[PATCH] perf docs: Fix perf-check manual page built with asciidoctor
authorBen Hutchings <benh@debian.org>
Sun, 23 Mar 2025 20:04:02 +0000 (21:04 +0100)
committerSalvatore Bonaccorso <carnil@debian.org>
Sat, 7 Jun 2025 12:21:10 +0000 (14:21 +0200)
commit7ccf5deeb99342890f5ce174a40e1682467ce44f
tree87d36a61500144ccac96fa57df50421570980df6
parentcfe9b291e6401490fdf2abee5f4ead0c5b576efd
[PATCH] perf docs: Fix perf-check manual page built with asciidoctor

Forwarded: https://lore.kernel.org/linux-perf-users/Z-BxCE8WrcRmR_5f@decadent.org.uk/

asciidoctor is more picky than asciidoc about the length of heading
underlines, and currently mis-parses perf-check.txt:

  ASCIIDOC perf-check.1
asciidoctor: ERROR: perf-check.txt: line 1: non-conforming manpage title
asciidoctor: ERROR: perf-check.txt: line 1: name section expected
asciidoctor: WARNING: perf-check.txt: line 2: unterminated example block
asciidoctor: WARNING: perf-check.txt: line 5: unterminated listing block

Fix the length of the title underline so it works properly.

Fixes: 98ad0b77323c ("perf check: Introduce 'check' subcommand")
Signed-off-by: Ben Hutchings <benh@debian.org>
Gbp-Pq: Topic bugfix/all
Gbp-Pq: Name perf-docs-Fix-perf-check-manual-page-built-with-asci.patch
tools/perf/Documentation/perf-check.txt